From d925a72d34a2cf1eb3427abf928f2ca257504c9b Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sun, 30 Dec 2001 22:56:05 +0000 Subject: [PATCH] Additions. * gtk/tmpl/gtkpixmap.sgml, gtk/tmpl/gtkscale.sgml, gtk/tmpl/gtkmain.sgml, gtk/tmpl/gtkimcontextsimple.sgml: Additions. * gtk/gtkwindow.c, gtk/gtkimcontextsimple.c: Minor documentation tweaks. --- ChangeLog | 4 ++ ChangeLog.pre-2-0 | 4 ++ ChangeLog.pre-2-10 | 4 ++ ChangeLog.pre-2-2 | 4 ++ ChangeLog.pre-2-4 | 4 ++ ChangeLog.pre-2-6 | 4 ++ ChangeLog.pre-2-8 | 4 ++ docs/reference/ChangeLog | 5 ++ .../gtk/tmpl/gtkimcontextsimple.sgml | 2 +- docs/reference/gtk/tmpl/gtkmain.sgml | 48 ++++++++++--------- docs/reference/gtk/tmpl/gtkpixmap.sgml | 3 +- docs/reference/gtk/tmpl/gtkscale.sgml | 21 ++++---- gtk/gtkimcontextsimple.c | 12 ++--- gtk/gtkwindow.c | 30 ++++++------ 14 files changed, 94 insertions(+), 55 deletions(-) diff --git a/ChangeLog b/ChangeLog index 4f5070bfdc..4aeb6d92a8 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2001-12-30 Matthias Clasen + + * gtk/gtkwindow.c, gtk/gtkimcontextsimple.c: Minor documentation tweaks. + 2001-12-28 Matthias Clasen * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c: diff --git a/ChangeLog.pre-2-0 b/ChangeLog.pre-2-0 index 4f5070bfdc..4aeb6d92a8 100644 --- a/ChangeLog.pre-2-0 +++ b/ChangeLog.pre-2-0 @@ -1,3 +1,7 @@ +2001-12-30 Matthias Clasen + + * gtk/gtkwindow.c, gtk/gtkimcontextsimple.c: Minor documentation tweaks. + 2001-12-28 Matthias Clasen * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c: diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index 4f5070bfdc..4aeb6d92a8 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,3 +1,7 @@ +2001-12-30 Matthias Clasen + + * gtk/gtkwindow.c, gtk/gtkimcontextsimple.c: Minor documentation tweaks. + 2001-12-28 Matthias Clasen * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c: diff --git a/ChangeLog.pre-2-2 b/ChangeLog.pre-2-2 index 4f5070bfdc..4aeb6d92a8 100644 --- a/ChangeLog.pre-2-2 +++ b/ChangeLog.pre-2-2 @@ -1,3 +1,7 @@ +2001-12-30 Matthias Clasen + + * gtk/gtkwindow.c, gtk/gtkimcontextsimple.c: Minor documentation tweaks. + 2001-12-28 Matthias Clasen * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c: diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4 index 4f5070bfdc..4aeb6d92a8 100644 --- a/ChangeLog.pre-2-4 +++ b/ChangeLog.pre-2-4 @@ -1,3 +1,7 @@ +2001-12-30 Matthias Clasen + + * gtk/gtkwindow.c, gtk/gtkimcontextsimple.c: Minor documentation tweaks. + 2001-12-28 Matthias Clasen * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c: diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6 index 4f5070bfdc..4aeb6d92a8 100644 --- a/ChangeLog.pre-2-6 +++ b/ChangeLog.pre-2-6 @@ -1,3 +1,7 @@ +2001-12-30 Matthias Clasen + + * gtk/gtkwindow.c, gtk/gtkimcontextsimple.c: Minor documentation tweaks. + 2001-12-28 Matthias Clasen * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c: diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index 4f5070bfdc..4aeb6d92a8 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,3 +1,7 @@ +2001-12-30 Matthias Clasen + + * gtk/gtkwindow.c, gtk/gtkimcontextsimple.c: Minor documentation tweaks. + 2001-12-28 Matthias Clasen * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c: diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 815deab4aa..c4f53d6b8c 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,8 @@ +2001-12-30 Matthias Clasen + + * gtk/tmpl/gtkpixmap.sgml, gtk/tmpl/gtkscale.sgml, + gtk/tmpl/gtkmain.sgml, gtk/tmpl/gtkimcontextsimple.sgml: Additions. + 2001-12-28 Matthias Clasen * gdk/tmpl/properties.sgml, gdk/tmpl/selections.sgml: Additions. diff --git a/docs/reference/gtk/tmpl/gtkimcontextsimple.sgml b/docs/reference/gtk/tmpl/gtkimcontextsimple.sgml index 16d67b3e81..fdf406ed30 100644 --- a/docs/reference/gtk/tmpl/gtkimcontextsimple.sgml +++ b/docs/reference/gtk/tmpl/gtkimcontextsimple.sgml @@ -41,7 +41,7 @@ GtkIMContextSimple - +The maximum length of sequences in compose tables. diff --git a/docs/reference/gtk/tmpl/gtkmain.sgml b/docs/reference/gtk/tmpl/gtkmain.sgml index 452b96c83c..c90ef7af94 100644 --- a/docs/reference/gtk/tmpl/gtkmain.sgml +++ b/docs/reference/gtk/tmpl/gtkmain.sgml @@ -279,7 +279,7 @@ the event: - Another point of interest might be that all keypresses are first passed + Another point of interest might be that all key events are first passed through the key snooper functions if there are any. Read the description of gtk_key_snooper_install() if you need this feature. @@ -556,24 +556,26 @@ Removes the idle function identified by the user data. - +Registers a function to be called when a condition becomes true +on a file descriptor. -@source: -@condition: -@function: -@marshal: -@data: -@destroy: -@Returns: +@source: a file descriptor. +@condition: the condition. +@function: The function to call. +@marshal: The marshaller to use instead of the function (if non-%NULL). +@data: callback data passed to @function. +@destroy: callback function to call with @data when the input + handler is removed, or %NULL. +@Returns: A unique id for the event source; to be used with gtk_input_remove(). - +Removes the function with the given id. -@input_handler_id: +@input_handler_id: Identifies the function to remove. @@ -636,31 +638,33 @@ This macro is deprecated. You should use %G_PRIORITY_LOW instead. - +Installs a key snooper function, which will get called on all key events +before delivering them normally. -@snooper: -@func_data: -@Returns: +@snooper: a #GtkKeySnoopFunc. +@func_data: data to pass to @snooper. +@Returns: a unique id for this key snooper for use with gtk_key_snooper_remove(). - +Key snooper functions are called before normal event delivery. +They can be used to implement custom key event handling. -@grab_widget: -@event: -@func_data: -@Returns: +@grab_widget: the widget to which the event will be delivered. +@event: the key event. +@func_data: the @func_data supplied to gtk_key_snooper_install(). +@Returns: %TRUE to stop further processing of @event, %FALSE to continue. - +Removes the key snooper function with the given id. -@snooper_handler_id: +@snooper_handler_id: Identifies the key snooper to remove. diff --git a/docs/reference/gtk/tmpl/gtkpixmap.sgml b/docs/reference/gtk/tmpl/gtkpixmap.sgml index 4370f2d7b5..1b0a071878 100644 --- a/docs/reference/gtk/tmpl/gtkpixmap.sgml +++ b/docs/reference/gtk/tmpl/gtkpixmap.sgml @@ -65,7 +65,8 @@ Gets the current #GdkPixmap and #GdkBitmap mask. - +Sets wether an extra pixmap should be automatically created and used +when the pixmap is insensitive. The default value is %TRUE. @pixmap: a #GtkPixmap. diff --git a/docs/reference/gtk/tmpl/gtkscale.sgml b/docs/reference/gtk/tmpl/gtkscale.sgml index d1251cef02..a2e1846c5d 100644 --- a/docs/reference/gtk/tmpl/gtkscale.sgml +++ b/docs/reference/gtk/tmpl/gtkscale.sgml @@ -69,7 +69,7 @@ slider. @scale: a #GtkScale. -@draw_value: +@draw_value: a boolean. @@ -83,29 +83,30 @@ Sets the position in which the current value is displayed. - +Gets the number of decimal places that are displayed in the value. -@scale: -@Returns: +@scale: a #GtkScale. +@Returns: the number of decimal places that are displayed. - +Returns whether the current value is displayed as a string next to the +slider. -@scale: -@Returns: +@scale: a #GtkScale. +@Returns: whether the current value is displayed as a string. - +Gets the position in which the current value is displayed. -@scale: -@Returns: +@scale: a #GtkScale. +@Returns: the position in which the current value is displayed. diff --git a/gtk/gtkimcontextsimple.c b/gtk/gtkimcontextsimple.c index e9a69d7e03..6c545e715c 100644 --- a/gtk/gtkimcontextsimple.c +++ b/gtk/gtkimcontextsimple.c @@ -1277,17 +1277,17 @@ gtk_im_context_simple_get_preedit_string (GtkIMContext *context, * @context_simple: A #GtkIMContextSimple * @data: the table * @max_seq_len: Maximum length of a sequence in the table - * (cannot be greater than 7) + * (cannot be greater than #GTK_MAX_COMPOSE_LEN) * @n_seqs: number of sequences in the table * - * Add an additional table to search to the input context. - * Each row of the table consists of max_seq_len key symbols - * followed by two guint16 interpreted as the high and low - * words of a gunicode value. Tables are searched starting + * Adds an additional table to search to the input context. + * Each row of the table consists of @max_seq_len key symbols + * followed by two #guint16 interpreted as the high and low + * words of a #gunicode value. Tables are searched starting * from the last added. * * The table must be sorted in dictionary order on the - * by numeric value of the key symbol fields. (Values beyond + * numeric value of the key symbol fields. (Values beyond * the length of the sequence should be zero.) **/ void diff --git a/gtk/gtkwindow.c b/gtk/gtkwindow.c index a518a30cb9..7a5153e084 100644 --- a/gtk/gtkwindow.c +++ b/gtk/gtkwindow.c @@ -845,7 +845,7 @@ gtk_window_get_title (GtkWindow *window) * Don't use this function. It sets the X Window System "class" and * "name" hints for a window. According to the ICCCM, you should * always set these to the same value for all windows in an - * application, and GTK sets them to that value by default, so calling + * application, and GTK+ sets them to that value by default, so calling * this function is sort of pointless. However, you may want to call * gtk_window_set_role() on each window in your application, for the * benefit of the session manager. Setting the role allows the window @@ -1318,7 +1318,7 @@ gtk_window_activate_focus (GtkWindow *window) * Retrieves the current focused widget within the window. * Note that this is the widget that would have the focus * if the toplevel window focused; if the toplevel window - * is not focused the GTK_WIDGET_HAS_FOCUS(widget) will + * is not focused then GTK_WIDGET_HAS_FOCUS (widget) will * not be %TRUE for the widget. * * Return value: the currently focused widget. @@ -1406,8 +1406,8 @@ gtk_window_get_modal (GtkWindow *window) * Returns a list of all existing toplevel windows. The widgets * in the list are not individually referenced. If you want * to iterate through the list and perform actions involving - * callbacks that might destroy the widgets, you MUST call - * g_list_foreach (result, (GFunc)g_object_ref, NULL) first, and + * callbacks that might destroy the widgets, you must call + * g_list_foreach (result, (GFunc)g_object_ref, NULL) first, and * then unref all the widgets afterwards. * * Return value: list of toplevel widgets @@ -1683,7 +1683,7 @@ gtk_window_get_type_hint (GtkWindow *window) * @window: a #GtkWindow * @setting: whether to destroy @window with its transient parent * - * If @setting is TRUE, then destroying the transient parent of @window + * If @setting is %TRUE, then destroying the transient parent of @window * will also destroy @window itself. This is useful for dialogs that * shouldn't persist beyond the lifetime of the main window they're * associated with, for example. @@ -2513,7 +2513,7 @@ gtk_window_resize (GtkWindow *window, * "configure_event" on the window and adjust your size-dependent * state to match the size delivered in the #GdkEventConfigure. * - * Note 2: The returned size does NOT include the size of the window + * Note 2: The returned size does not include the size of the window * manager decorations (aka the window frame or border). Those * are not drawn by GTK+ and GTK+ has no reliable method of * determining their size. @@ -2533,7 +2533,7 @@ gtk_window_resize (GtkWindow *window, * application cannot. * * In any case, if you insist on application-specified window - * positioning, there's STILL a better way than doing it yourself - + * positioning, there's still a better way than doing it yourself - * gtk_window_set_position() will frequently handle the details * for you. * @@ -2607,8 +2607,8 @@ gtk_window_get_size (GtkWindow *window, * the bottom-right corner of the window border will be placed at that * reference point. So, to place a window in the bottom right corner * you would first set gravity to south east, then write: - * gtk_window_move (window, gdk_screen_width () - window_width, - * gdk_screen_height () - window_height). + * gtk_window_move (window, gdk_screen_width () - window_width, + * gdk_screen_height () - window_height). * * The extended window manager hints specification at window, accessible in window->frame. Using the signal + * @window->window, accessible in @window->frame. Using the signal * frame_event you can recieve all events targeted at the frame. * * This function is used by the linux-fb port to implement managed @@ -4717,10 +4717,10 @@ gtk_window_set_has_frame (GtkWindow *window, * @window: a #GtkWindow * * Accessor for whether the window has a frame window exterior to - * widget->window. Gets the value set by gtk_window_set_has_frame (). + * @window->window. Gets the value set by gtk_window_set_has_frame (). * * Return value: %TRUE if a frame has been added to the window - * via gtk_widow_has_frame + * via gtk_window_set_has_frame(). **/ gboolean gtk_window_get_has_frame (GtkWindow *window) @@ -4743,7 +4743,7 @@ gtk_window_get_has_frame (GtkWindow *window) * window border drawn by the window manager, which is the normal * case when using the X Window system.) * - * For windows with frames (see #gtk_window_set_has_frame) this function + * For windows with frames (see gtk_window_set_has_frame()) this function * can be used to change the size of the frame border. **/ void -- 2.30.2